Merciful 5/Merciful - Disc 5.iso/software/h/hypertextdatav40.12cr.lha/HTDS/Docs/man.hguide

Amiga HyperGuide | 1997-03-21 | 4.4 KB | 112 lines

@hyperguide man.hguide
@$VER: man.hguide 40.6 (07.03.97)
@macro m_prg "@{b}Man DataType@{ub}"
@macro m_tmplt "<@{i}$1@{ui}>"
@include htds.hgm

@node main "Man DataType Documentation"
@toc HTDS.hguide/main
@prev productinfo.hguide/main
@next

@{jcenter}@{m_title}@{m_copyright}@{m_welcome}@{jleft}

@{settabs 30}
@{m_sec Menu}
@{m_menuitem}@{" Configuration " link Configuration                }@{m_menuinfo "Adapt to your needs"}
@{m_menuitem}@{" Searching pages " link LocatingPages              }@{m_menuinfo "How man pages are located"}
@{m_menuitem}@{" Format Notes "  link Notes                        }@{m_menuinfo "Whats NRoff ?"}
@{m_menuitem}@{" Attributes "    link hypertext.hguide/CommonAttrs }@{m_menuinfo "Using HyperGuide attributes"}
@{m_menuitem}@{" Base Datatype " link hypertext.hguide/main        }@{m_menuinfo "The HyperText Datatype"}
@{line}
@{m_menuitem}@{" Copyright "     link HTDS.hguide/Copyright        }@{m_menuinfo "legal stuff"}
@{m_menuitem}@{" Author "        link SR.hguide/Addresses          }@{m_menuinfo "how to contact me"}
@{m_menuitem}@{" Registration "  link HTDS.hguide/Registration     }@{m_menuinfo "It's Shareware !!!"}
@{m_endsec}

@endnode
@node Configuration "Man DataType/Configuration"

@{m_sec "Configuration"}
As the recommended standard for datatypes, the preference file for the
man.datatype is called @{m_file man.prefs} and is searched first in
the @{m_file PROGDIR:Prefs/DataTypes} and then in @{m_file Env:DataTypes} directory.
The following options are currently available using ReadArgs() argument parsing :

@{itemize}
@{item}PATH/K,BOLD/K,UNDERLINED/K,SECTIONNAME/K
@{definition}
@{defterm}PATH
@{defdata}specifies the root directory of the man page system (e.g. gnu:man or man:)
Default is @{m_file "ADE:man"}

@{defterm}BOLD
@{defdata}specifies the @{"HyperGuide style" link hypertext.hguide/CommonAttrs}
string to use for bold man page words. Default is "\@{b}"

@{defterm}UNDERLINED
@{defdata}specifies the @{"HyperGuide style" link hypertext.hguide/CommonAttrs}
string to use for underlined man page words. Default is "\@{u}"

@{defterm}SECTIONNAME
@{defdata}specifies the @{"HyperGuide style" link hypertext.hguide/CommonAttrs}
string to use for section names. Default is "\@{i}"
@{enddefinition}
@{enditemize}
@{m_endsec}
@endnode
@node LocatingPages "Man DataType/Locating man pages"

@{m_sec "Locating man pages"}
The man.datatype searches a linked man page dynamically. This means, if you
trigger a link, it tries to find the man page in the following directories
and order :

@{enumerate}
@{item}@{m_tmplt manpath}cat@{m_tmplt sectionnr}/@{m_tmplt manpage}.0
@{item}@{m_tmplt manpath}cat@{m_tmplt sectionnr}/@{m_tmplt manpage}.1
@{item}@{m_tmplt manpath}cat@{m_tmplt sectionnr}/@{m_tmplt manpage}.@{m_tmplt sectionnr}
@{item}@{m_tmplt manpath}cat@{m_tmplt sectionnr}/@{m_tmplt manpage}.0.gz
@{item}@{m_tmplt manpath}cat@{m_tmplt sectionnr}/@{m_tmplt manpage}.1.gz
@{item}@{m_tmplt manpath}cat@{m_tmplt sectionnr}/@{m_tmplt manpage}.@{m_tmplt sectionnr}.gz
@{item}@{m_tmplt manpath}man@{m_tmplt sectionnr}/@{m_tmplt manpage}.0
@{item}@{m_tmplt manpath}man@{m_tmplt sectionnr}/@{m_tmplt manpage}.1
@{item}@{m_tmplt manpath}man@{m_tmplt sectionnr}/@{m_tmplt manpage}.@{m_tmplt sectionnr}
@{item}@{m_tmplt manpath}man@{m_tmplt sectionnr}/@{m_tmplt manpage}.0.gz
@{item}@{m_tmplt manpath}man@{m_tmplt sectionnr}/@{m_tmplt manpage}.1.gz
@{item}@{m_tmplt manpath}man@{m_tmplt sectionnr}/@{m_tmplt manpage}.@{m_tmplt sectionnr}.gz
@{endenumerate}

@{definition}
where is :
@{defterm}@{m_tmplt manpath}
@{defdata}the the root man page directory (See @{"Configuration" link Configuration})

@{defterm}@{m_tmplt sectionnr}
@{defdata}the number in the parenthesis of the link

@{defterm}@{m_tmplt manpage}
@{defdata}the name of the link.
@{enddefinition}
@{m_endsec}

@{m_sec "See Also"}
@{" Configuration " link Configuration}, @{" Format Notes " link Notes}
@{m_endsec}
@endnode
@node Notes "Man DataType/Format Notes"

@{m_sec "Format Notes"}
This datatype can only operate on Unix manual pages in ASCII format. The
source of each manual page is written in a typesetting format called NRoff.
Such files have to be compiled into resulting ASCII files. This can be done
with the @{m_file groff} command.


For the datatypes system you can use my new V39.4 cli.datatype to
transparently process NRoff files. You need also this datatype to use
gzipped man pages transparently like in the new ADE environment.
@{m_endsec}
@endnode